4.3.4.4 查询组织架构列表
可通过此接口在用户目录查询组织架构列表。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/group/queryAll请求方式：
POST
请求头（Header）
- 请求体（Body）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识，在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local。外部用户目录示例： custom01339（唯一标识无需携带@） |
| pageSize | 分页大小 | 否 | number | 查询数据会自动分页，此参数为每页包含数据的最大条数。 取值范围：0 < 分页大小 <= 5000。 默认值：20 |
| pageIndex | 分页索引 | 否 | number | 查询数据会自动分页，此参数为待查询的页面序号。 取值范围：0 < 分页索引 <= 1000000。 默认值：1 |
| searchByPath | 根据组织架构精确搜索 | 否 | string | 根据组织架构路径，精确搜索其下的子组织架构。 示例：/客服体系/专家中心/零信任专家组 |
| recursive | 根据组织架构精确搜索时，是否递归搜索子组 | 否 | number | 取值范围：1-递归（默认）0-不递归 |
| fuzzyMatch | 模糊搜索 | 否 | string | 针对组织架构名称（忽略大小写）进行模糊匹配。 当存在 searchByPath 参数时，此参数将失效。 |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/group/queryAll?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"directoryDomain": "custom01339",
"pageSize": 20,
"pageIndex": 1,
"searchByPath": "/",
"recursive": 1
}'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | number | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | |
| ├─ count | 数据总条数 | number | |
| ├─ pageCount | 当前页包含数据条数 | number | |
| ├─ pageSize | 分页大小参数 | number | |
| ├─ pageIndex | 分页索引参数 | number | |
| ├─ data | 组织架构数据 | object[] | |
| ├─├─ id | id | string | 示例： 2000dfe1-e4fe-11ee-bee9-fefcfeefe529 |
| ├─├─ name | 所属组织架构的名称 | string | 示例： 当前所属组织架构为 /客服体系/专家中心/零信任专家组，则所属组织架构的名称为：c |
| ├─├─ path | 所属组织架构的路径 | string | 示例： 当前所属组织架构为 /客服体系/专家中心/零信任专家组，则所属组织架构的路径为：/客服体系/专家中心 |
| ├─├─ description | 描述信息 | string | |
| ├─├─ externalId | 外部id | string | 示例： 81dc9bdb52d04dc2 |
| ├─├─ isDeleted | 是否外部已删除 | number | 取值范围：0-否1-是 |
| msg | 描述信息 | string | |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"count": 2,
"pageCount": 1,
"pageSize": 20,
"pageIndex": 1,
"data": [
{
"id": "a662ec20-b9a4-11ee-9574-3501cced60d3",
"name": "a",
"path": "/",
"description": "grp a desc",
"externalId": "group-extid-a",
"isDeleted": 0
},
{
"id": "e1505bf0-b9a0-11ee-9253-273cb56860da",
"name": "new",
"path": "/",
"description": "",
"externalId": "e6266a6d2478377be81817c9391c2cc6",
"isDeleted": 0
}
]
},
"msg": "请求成功",
"traceId": "00459fbd6c5e9fc0"
}
错误码